[Resource] az bicep: Add snapshot and run subcommands#33398
Open
shenglol wants to merge 1 commit into
Open
Conversation
- `az bicep snapshot`: Wraps the Bicep CLI `snapshot` command (introduced in Bicep CLI 0.41.2) to capture or validate deployment snapshots from a .bicepparam file. Supports `--mode`, `--tenant-id`, `--subscription-id`, `--management-group-id`, `--location`, `--resource-group`, and `--deployment-name`. - `az bicep run`: Generic passthrough that forwards a quoted command string to the installed Bicep CLI, allowing use of CLI features that don't yet have a dedicated `az bicep` wrapper. - Uses `shlex.split(..., posix=False)` plus quote stripping so Windows paths with backslashes are preserved. - Adds unit tests (TestBicepSnapshot, TestBicepRun) and LiveScenarioTests (BicepSnapshotTest, BicepRunTest).
shenglol
requested review from
ReaNAiveD,
isra-fel,
notyashhh,
teresaritorto and
xuming-ms
as code owners
️✔️AzureCLI-FullTest
|
|
Hi @shenglol, |
|
| rule | cmd_name | rule_message | suggest_message |
|---|---|---|---|
| bicep run | cmd bicep run added |
||
| bicep snapshot | cmd bicep snapshot added |
microsoft-github-policy-service
Bot
added
ARM
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds two new Bicep subcommands to the resource module: az bicep snapshot (wraps Bicep CLI's snapshot command, requires Bicep CLI v0.41.2+) and az bicep run (generic passthrough that forwards a quoted command string to the Bicep CLI, preserving Windows-style backslashes via shlex non-POSIX mode).
Changes:
- Implements
snapshot_bicep_fileandrun_bicep_cli_passthroughincustom.py, wired up viacommands.py,_params.py, and_help.py. - Adds unit tests covering argument forwarding, version-gating, quote handling, and empty-command validation.
- Adds
LiveScenarioTestclasses exercising the new commands end-to-end against the installed Bicep CLI.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| src/azure-cli/azure/cli/command_modules/resource/custom.py | Adds snapshot_bicep_file and run_bicep_cli_passthrough implementations. |
| src/azure-cli/azure/cli/command_modules/resource/commands.py | Registers the new snapshot and run commands under the bicep group. |
| src/azure-cli/azure/cli/command_modules/resource/_params.py | Declares arguments for the new commands. |
| src/azure-cli/azure/cli/command_modules/resource/_help.py | Adds help text and examples for bicep snapshot and bicep run. |
| src/azure-cli/azure/cli/command_modules/resource/tests/latest/test_resource_bicep.py | Adds unit tests for the new custom functions. |
| src/azure-cli/azure/cli/command_modules/resource/tests/latest/test_resource.py | Adds live scenario tests for bicep snapshot and bicep run. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+5673
to
+5676
| class BicepSnapshotTest(LiveScenarioTest): | ||
| def setup(self): | ||
| super().setup() | ||
| self.cmd('az bicep uninstall') |
Comment on lines
+5702
to
+5705
| class BicepRunTest(LiveScenarioTest): | ||
| def setup(self): | ||
| super().setup() | ||
| self.cmd('az bicep uninstall') |
Comment on lines
+5683
to
+5685
| curr_dir = os.path.dirname(os.path.realpath(__file__)) | ||
| params_file = os.path.join(curr_dir, 'sample_params.bicepparam').replace('\\', '\\\\') | ||
| snapshot_path = os.path.join(curr_dir, 'sample_params.snapshot.json') |
Comment on lines
+4614
to
+4621
| def run_bicep_cli_passthrough(cmd, command_string): | ||
| import shlex | ||
|
|
||
| # Use non-POSIX mode so that backslashes in Windows paths are preserved. | ||
| # In non-POSIX mode, shlex retains the surrounding quotes on quoted tokens, | ||
| # so strip them so the values are passed through cleanly to the Bicep CLI. | ||
| args = [] | ||
| for token in shlex.split(command_string, posix=False): |
Comment on lines
+4610
to
+4611
| else: | ||
| logger.error("az bicep snapshot could not be executed with the current version of Bicep CLI. Please upgrade Bicep CLI to v%s or later.", minimum_supported_version) |
| c.argument('mode', arg_type=get_enum_type(['Overwrite', 'Validate']), | ||
| help="The snapshot mode. 'Overwrite' (default) writes the snapshot file. 'Validate' compares the existing snapshot against the current template and fails if differences are detected.") | ||
| c.argument('tenant_id', options_list=['--tenant-id'], help="The Azure tenant ID to use when capturing the snapshot.") | ||
| c.argument('subscription_id', options_list=['--subscription-id'], help="The Azure subscription ID to use when capturing the snapshot.") |
Comment on lines
+767
to
+768
| c.argument('location', options_list=['--location'], help="The Azure location to use when capturing the snapshot.") | ||
| c.argument('resource_group', options_list=['--resource-group'], help="The Azure resource group name to use when capturing the snapshot.") |
Comment on lines
+4614
to
+4615
| def run_bicep_cli_passthrough(cmd, command_string): | ||
| import shlex |
Collaborator
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related command
az bicep snapshotaz bicep runDescription
az bicep snapshot: Wraps the Bicep CLIsnapshotcommand (introduced in Bicep CLI 0.41.2) to capture or validate deployment snapshots from a .bicepparam file. Supports--mode,--tenant-id,--subscription-id,--management-group-id,--location,--resource-group, and--deployment-name.az bicep run: Generic passthrough that forwards a quoted command string to the installed Bicep CLI, allowing use of CLI features that don't yet have a dedicatedaz bicepwrapper.shlex.split(..., posix=False)plus quote stripping so Windows paths with backslashes are preserved.Closes Azure/bicep#19502.
Testing Guide
History Notes
az bicep snapshot: New command to wrap the Bicep CLIsnapshotcommand to capture or validate deployment snapshots from a .bicepparam file.az bicep run: New command that forwards a quoted command string to the Bicep CLI, allowing use of CLI features that don't yet have a dedicatedaz bicepwrapper.This checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.